UserApi
All URIs are relative to //api.estuary.tech/
| Method | HTTP request | Description |
|---|---|---|
| UserApiKeysGet | Get /user/api-keys | Get API keys for a user |
| UserApiKeysKeyOrHashDelete | Delete /user/api-keys/{key_or_hash} | Revoke a User API Key. |
| UserApiKeysPost | Post /user/api-keys | Create API keys for a user |
| UserExportGet | Get /user/export | Export user data |
| UserStatsGet | Get /user/stats | Get stats for the current user |
UserApiKeysGet
[]ApiGetApiKeysResp UserApiKeysGet(ctx, ) Get API keys for a user
This endpoint is used to get API keys for a user. In estuary, each user can be given multiple API keys (tokens). This endpoint can be used to retrieve all available API keys for a given user.
Required Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserApiKeysKeyOrHashDelete
string UserApiKeysKeyOrHashDelete(ctx, keyOrHash) Revoke a User API Key.
This endpoint is used to revoke a user API key. In estuary, every user is assigned with an API key, this API key is generated and issued for each user and is primarily used to access all estuary features. This endpoint can be used to revoke the API key that's assigned to the user. Revoked API keys are completely deleted and are not recoverable.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| keyOrHash | string | Key or Hash |
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserApiKeysPost
ApiGetApiKeysResp UserApiKeysPost(ctx, optional) Create API keys for a user
This endpoint is used to create API keys for a user. In estuary, each user is given an API key to access all features.
Required Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *UserApiUserApiKeysPostOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a UserApiUserApiKeysPostOpts struct Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- expiry | optional.String| Expiration - Expiration - Valid time units are ns, us (or µs), ms, s, m, h. for example 300h | perms | optional.String| Permissions -- currently unused |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserExportGet
string UserExportGet(ctx, ) Export user data
This endpoint is used to get API keys for a user.
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UserStatsGet
string UserStatsGet(ctx, ) Get stats for the current user
This endpoint is used to get stats for the current user.
Required Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]